---
title: ワークブックデータ構造
icon: NotebookTabs
---

## IWorkbookData

[`IWorkbookData`](https://reference.univer.ai/en-US/interfaces/IWorkbookData) は Univer Sheet におけるワークブックのスナップショットを表します。

### プロパティ

| プロパティ | タイプ | 説明 |
|----------|------|-------------|
| id | `string` | Univer Sheets の一意識別子。 |
| name | `string` | Univer Sheets の名前。 |
| appVersion | `string` | Univer モデル定義のバージョン。 |
| locale | `LocaleType` | ドキュメントのロケール。 |
| styles | `Record<string, Nullable<IStyleData>>` | ワークブックのスタイル参照。 |
| sheetOrder | `string[]` | ワークシートの順序を表すシート ID の配列。 |
| sheets | `{ [sheetId: string]: Partial<IWorksheetData> }` | 各ワークシートのデータを含むレコード。 |
| resources? | `IResources` | プラグインのデータを格納 |

### 例

```typescript
const workbookData: IWorkbookData = {
  id: 'unique-workbook-id',
  name: 'My Workbook',
  appVersion: '0.10.2',
  locale: LocaleType.EN_US,
  styles: { /* スタイル定義 */ },
  sheetOrder: ['sheet1', 'sheet2'],
  sheets: {
    sheet1: { /* シートデータ */ },
    sheet2: { /* シートデータ */ },
  },
}
```

### 使い方

IWorkbookData は Univer Sheets でデータを格納するために使用されるオブジェクトです。主に以下の用途で使用されます：

1. [IWorkbookData を使用した Univer Sheets の作成](/guides/sheets/features/core/sheets-api#create-worksheet)
2. [Univer Sheets からの IWorkbookData の保存](/guides/sheets/features/core/sheets-api#get-workbook-data)

`resources` プロパティはプラグインデータを格納するために使用されます。[プラグインカスタムモデル](/guides/recipes/tutorials/custom-model) を参照してください
